5.1. Common Elements and types
The following tables define the base types for requests and responses. All CalWS-SOAP messages and responses are based on these types.
All requests must include an href which specifies the target for the request. There is also an id attribute which will be copied into the response to help identify it.
Field | Type | # | ? | Description |
|---|---|---|---|---|
href | string | 1 | Y | Required in each request to identify the target of the message. |
#id | int | 1 | N | Useful for tying responses to requests. |
A response may include an error response element of type ErrorResponseType. This element will be returned in response messages when some form of processing error occurs and provides further information on the error beyond the basic status code.
Field | Type | # | ? | Description |
|---|---|---|---|---|
? | ErrorCodeType | 1 | Y | One of the error code elements defined below |
description | string | 0..1 | N | Optional descriptive message |